Skip to content

docs(eval): add README for running evals locally#249

Merged
rh-hemartin merged 1 commit into
mainfrom
agent/247-eval-readme
Jul 22, 2026
Merged

docs(eval): add README for running evals locally#249
rh-hemartin merged 1 commit into
mainfrom
agent/247-eval-readme

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

  • Add eval/README.md documenting how to run agent evals locally
  • Covers prerequisites (tools, GCP credentials, GitHub token scopes), required env vars, run commands, test case structure, and known issues
  • Documents both review and triage eval workflows since they share the same infrastructure

Closes #247

Test plan

🤖 Generated with Claude Code


Closes #247

Post-script verification

  • Branch is not main/master (agent/247-eval-readme)
  • Secret scan passed (gitleaks — def8cb529ebf40b98eb0c0b67a2793b46f7648e4..HEAD)
  • PR body secret scan passed (gitleaks — no-git)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

@fullsend-ai-coder
fullsend-ai-coder Bot requested a review from a team as a code owner July 17, 2026 08:57
@ben-alkov ben-alkov added the documentation Improvements or additions to documentation label Jul 17, 2026
@rh-hemartin rh-hemartin self-assigned this Jul 22, 2026
@rh-hemartin

Copy link
Copy Markdown
Member

/fs-fix rebase and solve the conflicts

@fullsend-ai-coder

fullsend-ai-coder Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Finished Fix · ✅ Success · Started 9:53 AM UTC · Completed 9:58 AM UTC
Commit: 7ada4e0 · View workflow run →

Document prerequisites, required env vars, run commands, test case
structure, and known issues for the eval framework. Covers both
review and triage agents.

Closes #247

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@fullsend-ai-coder

Copy link
Copy Markdown
Contributor Author

🔧 Fix agent — iteration 1 (human-triggered)

Rebased onto origin/main and resolved add/add conflict in eval/README.md by merging both versions into a cohesive document. Pre-existing test failure (prerequisites-creates-allowed-issue) is unrelated to this docs change.

Fixed (1):

  1. rebase and solve the conflicts: Rebased branch agent/247-eval-readme onto origin/main. Resolved add/add conflict in eval/README.md by merging content from both the main version (PR docs(eval): document required env vars and token scopes #248) and this PR's version. The main version provides the structural base (title, env var tables with Required/Optional/Derived sections, token scopes, lifecycle), while this PR's unique additions (three-phase description, linting cases, harness submodule setup, GCP credentials, AGENT_EVAL_HARNESS_DIR env var, test case structure, known issues) were incorporated into the merged document.

Tests: passed

Decision points
  • Chose to use main's eval/README.md as the structural base and merge in unique content from this PR's version (alternatives: Take PR branch version entirely and discard main's content, Take main's version entirely and discard PR branch content; rationale: Main's version (from PR docs(eval): document required env vars and token scopes #248) was already merged and is the authoritative base. This PR's purpose was to add documentation content, so its unique sections (phases description, linting, test case structure, known issues, harness submodule setup, GCP credentials) were merged in to preserve the value of both contributions.)

Updated by fullsend fix agent

@fullsend-ai-coder
fullsend-ai-coder Bot force-pushed the agent/247-eval-readme branch from 93edc38 to 15d57ad Compare July 22, 2026 09:58
@rh-hemartin

Copy link
Copy Markdown
Member

/fs-review

@fullsend-ai-review

fullsend-ai-review Bot commented Jul 22, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 10:06 AM UTC · Completed 10:14 AM UTC
Commit: 7ada4e0 · View workflow run →

@fullsend-ai-review

Copy link
Copy Markdown

Looks good to me

@fullsend-ai-review fullsend-ai-review Bot added the ready-for-merge All reviewers approved — ready to merge label Jul 22, 2026
@rh-hemartin
rh-hemartin added this pull request to the merge queue Jul 22, 2026
Merged via the queue into main with commit ccbe67f Jul 22, 2026
20 checks passed
@rh-hemartin
rh-hemartin deleted the agent/247-eval-readme branch July 22, 2026 10:17
@fullsend-ai-retro

fullsend-ai-retro Bot commented Jul 22, 2026

Copy link
Copy Markdown

🤖 Finished Retro · ✅ Success · Started 10:20 AM UTC · Completed 10:32 AM UTC
Commit: 15d57ad · View workflow run →

@fullsend-ai-retro

Copy link
Copy Markdown

Retro: PR #249 — docs(eval): add README for running evals locally

Timeline

Time Event Agent Cost
Jul 17, 08:47 Issue #247 filed by rh-hemartin
Jul 17, 08:47–08:50 Triage: labeled documentation + ready-to-code, noted #246 is a subset triage $0.35
Jul 17, 08:51–08:57 Code: created eval/README.md, opened PR #249 code $1.53
(concurrent) Issue #246 also triaged and coded → PR #248 created at 08:56 with same file code
Jul 22, 07:24 PR #248 (#246) merged first, creating add/add conflict for #249
Jul 22, 09:51 Human triggered /fs-fix rebase and solve the conflicts
Jul 22, 09:52–09:59 Fix: rebased, intelligently merged both README versions fix $1.18
Jul 22, 10:04 Human triggered /fs-review
Jul 22, 10:05–10:14 Review: 3 sub-agents verified correctness, style, intent — zero findings, approved review $2.18
Jul 22, 10:15 Human approved (no additional comments)
Jul 22, 10:17 PR merged

Total cost: ~$5.24 across 4 agent runs.

What went well

  1. Fast pipeline: Issue → triage → code → PR in ~10 minutes. The triage agent correctly classified the issue and the code agent read 11 eval scripts to produce thorough, factually accurate documentation.
  2. Fix agent quality: Resolved the add/add conflict by intelligently merging PR docs(eval): document required env vars and token scopes #248's authoritative structure with PR docs(eval): add README for running evals locally #249's unique content (three-phase execution, linting, GCP credentials, known issues). Not a simple take-ours/theirs — genuine document-level merge.
  3. Review thoroughness: The correctness sub-agent cross-referenced every technical claim (env vars, CLI commands, directory structure, token derivation) against actual scripts. Zero false positives, appropriate approval verdict.
  4. Cost efficiency: High cache-read ratios across all agents (code agent: 1.4M cache_read vs 100K cache_create). The code agent produced 63 lines of accurate documentation in 3 minutes of agent time for $1.53.

What could improve

  1. Parallel code agents on overlapping issues: Issues Document EVAL_GH_TOKEN permissions for review eval #246 and Document how to run review eval locally #247 were filed near-simultaneously. Both code agents created eval/README.md independently, causing an add/add conflict that required a fix agent run ($1.18) plus human intervention to trigger it. The triage agent for Document how to run review eval locally #247 identified Document EVAL_GH_TOKEN permissions for review eval #246 as "a subset that could be subsumed" but didn't act on this knowledge. See proposal below.

  2. Minor doc completeness gap: The review correctness sub-agent verified all claims present in the README but did not flag the omission of EVALS_HOST_CREDENTIALS (used in run-functional.sh line 161 for host-side GCP credential overrides). This is a niche CI-specific variable, so the omission is understandable. Existing issue #261 (review agent should evaluate information architecture of new documentation) covers this class of improvement.

Autonomy evidence

The review agent fully covered the human review on this docs-only PR — both approved with zero findings, zero delta. The correctness sub-agent's verification was thorough (cross-referencing env vars, CLI commands, and file paths against 6+ shell scripts). This adds evidence to the pattern tracked in fullsend-ai/fullsend#5289 (review agent autonomy on docs-only PRs). Related tracking issues: fullsend#4765, fullsend#5289.

Existing issue evidence

Proposals filed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready-for-merge All reviewers approved — ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document how to run review eval locally

2 participants